AddPolygonToRegion(RasterRegionXForm,RasterCollection<LeadPoint>,LeadFillMode,RasterRegionCombineMode) Method

Creates or updates the image region by adding a polygonal region.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public void AddPolygonToRegion( 
   RasterRegionXForm xform,
   RasterCollection<LeadPoint> points,
   LeadFillMode fillMode,
   RasterRegionCombineMode combineMode
)

'Declaration
 
Public Overloads Sub AddPolygonToRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal points As RasterCollection(Of LeadPoint), _
   ByVal fillMode As LeadFillMode, _
   ByVal combineMode As RasterRegionCombineMode _
)

'Usage
 
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim points As RasterCollection(Of LeadPoint)
Dim fillMode As LeadFillMode
Dim combineMode As RasterRegionCombineMode
 
instance.AddPolygonToRegion(xform, points, fillMode, combineMode)

public void AddPolygonToRegion( 
   RasterRegionXForm xform,
   RasterCollection<LeadPoint> points,
   LeadFillMode fillMode,
   RasterRegionCombineMode combineMode
)

 function Leadtools.RasterImage.AddPolygonToRegion(RasterRegionXForm,RasterCollection{LeadPoint},LeadFillMode,RasterRegionCombineMode)( 
   xform ,
   points ,
   fillMode ,
   combineMode 
)

public:
void AddPolygonToRegion( 
   RasterRegionXForm^ xform,
   RasterCollection<LeadPoint>^ points,
   LeadFillMode fillMode,
   RasterRegionCombineMode combineMode
)

Parameters

xform

RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.

points

A collection of LeadPoint objects. The points in the collection must be in the order in which the vertices of the polygon are connected. To create the line that closes the polygon, the last point in the collection is connected to the first point of the collection.

fillMode

Indicates how to handle complex crossing lines.

Value	Meaning
LeadPoint.Winding	All pixels that are inside the resulting exterior lines are in the region.
LeadFillMode.Alternate	The region includes the area between odd-numbered and even-numbered polygon sides on each scan line.

Fill Mode

combineMode

The action to take regarding the existing image region, if one is defined.

Remarks

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub AddPolygonToRegionExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddPolygonToRegion.bmp")

      ' Load the image
      Dim image As RasterImage = codecs.Load(srcFileName)

      ' Add a polygon region

      Dim xform As RasterRegionXForm = New RasterRegionXForm()
      xform.ViewPerspective = RasterViewPerspective.TopLeft
      xform.XOffset = 0
      xform.YOffset = 0
      xform.XScalarDenominator = 1
      xform.XScalarNumerator = 1
      xform.YScalarDenominator = 1
      xform.YScalarNumerator = 1

      Dim x1 As Integer = image.ImageWidth \ 4
      Dim y1 As Integer = image.ImageHeight \ 4
      Dim x2 As Integer = image.ImageWidth \ 3
      Dim y2 As Integer = image.ImageHeight \ 3

      Dim pts As LeadPoint() = {New LeadPoint(x1, y1), New LeadPoint(x2, y1), New LeadPoint(x1, y2), New LeadPoint(x2, y2)}

      image.AddPolygonToRegion(xform, pts, LeadFillMode.Winding, RasterRegionCombineMode.Set)

      ' Draw something on the image
      Dim command As InvertCommand = New InvertCommand()
      command.Run(image)

      ' Save the image
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)

      image.Dispose()
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void AddPolygonToRegionExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddPolygonToRegion.bmp");

      // Load the image
      RasterImage image = codecs.Load(srcFileName);

      // Add a polygon region

      RasterRegionXForm xform = new RasterRegionXForm();
      xform.ViewPerspective = RasterViewPerspective.TopLeft;
      xform.XOffset = 0;
      xform.YOffset = 0;
      xform.XScalarDenominator = 1;
      xform.XScalarNumerator = 1;
      xform.YScalarDenominator = 1;
      xform.YScalarNumerator = 1;

      int x1 = image.ImageWidth / 4;
      int y1 = image.ImageHeight / 4;
      int x2 = image.ImageWidth / 3;
      int y2 = image.ImageHeight / 3;

      LeadPoint[] pts =
      {
         new LeadPoint(x1, y1),
         new LeadPoint(x2, y1),
         new LeadPoint(x1, y2),
         new LeadPoint(x2, y2)
      };

      image.AddPolygonToRegion(xform, pts, LeadFillMode.Winding, RasterRegionCombineMode.Set);

      // Draw something on the image
      InvertCommand command = new InvertCommand();
      command.Run(image);

      // Save the image
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24);

      image.Dispose();
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

RasterImageExamples.prototype.AddPolygonToRegionExample = function () {
   Tools.SetLicense();
   with (Leadtools) {
      with (Leadtools.Codecs) {
         var codecs = new RasterCodecs();

         var srcFileName = "Assets\\Image1.cmp";
         var destFileName = "Image1_AddPolygonToRegion.bmp";
         var image;
         // Load the image
         return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
            return codecs.loadAsync(LeadStreamFactory.create(loadFile))
         })
            .then(function (img) {
               image = img;

               // Add a polygon region

               var xform = new RasterRegionXForm();
               xform.viewPerspective = RasterViewPerspective.topLeft;
               xform.xoffset = 0;
               xform.yoffset = 0;
               xform.xscalarDenominator = 1;
               xform.xscalarNumerator = 1;
               xform.yscalarDenominator = 1;
               xform.yscalarNumerator = 1;

               var x1 = image.imageWidth / 4;
               var y1 = image.imageHeight / 4;
               var x2 = image.imageWidth / 3;
               var y2 = image.imageHeight / 3;

               var pts =
               [
                  LeadPointHelper.create(x1, y1),
                  LeadPointHelper.create(x2, y1),
                  LeadPointHelper.create(x1, y2),
                  LeadPointHelper.create(x2, y2)
               ];

               image.addPolygonToRegion(xform, pts, LeadFillMode.winding, RasterRegionCombineMode.set);

               // Draw something on the image
               var command = new Leadtools.ImageProcessing.Color.InvertCommand();
               command.run(image);

               // Save the image
               return Tools.AppLocalFolder().createFileAsync(destFileName)
            })
            .then(function (saveFile) {
               var saveStream = LeadStreamFactory.create(saveFile);
               return codecs.saveAsync(image, saveStream, RasterImageFormat.bmp, 24)
            })
            .then(function () {

               image.close();
               codecs.close();
            });
      }
   }
}

[TestMethod]
public async Task AddPolygonToRegionExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.cmp";
   string destFileName = @"Image1_AddPolygonToRegion.bmp";

   // Load the image
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Add a polygon region

   RasterRegionXForm xform = new RasterRegionXForm();
   xform.ViewPerspective = RasterViewPerspective.TopLeft;
   xform.XOffset = 0;
   xform.YOffset = 0;
   xform.XScalarDenominator = 1;
   xform.XScalarNumerator = 1;
   xform.YScalarDenominator = 1;
   xform.YScalarNumerator = 1;

   int x1 = image.ImageWidth / 4;
   int y1 = image.ImageHeight / 4;
   int x2 = image.ImageWidth / 3;
   int y2 = image.ImageHeight / 3;

   LeadPoint[] pts =
   {
      LeadPointHelper.Create(x1, y1),
      LeadPointHelper.Create(x2, y1),
      LeadPointHelper.Create(x1, y2),
      LeadPointHelper.Create(x2, y2)
   };

   image.AddPolygonToRegion(xform, pts, LeadFillMode.Winding, RasterRegionCombineMode.Set);

   // Draw something on the image
   InvertCommand command = new InvertCommand();
   command.Run(image);

   // Save the image
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   ILeadStream saveStream = LeadStreamFactory.Create(saveFile);
   await codecs.SaveAsync(image, saveStream, RasterImageFormat.Bmp, 24);

   image.Dispose();
   codecs.Dispose();
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterImage Class
RasterImage Members
Overload List